home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / infpop25.zip / MAKEINFO.DOC < prev    next >
Text File  |  1992-05-22  |  8KB  |  207 lines
  1. MAKEINFO.DOC
  2.  
  3. (c) 1992, GMUtant Software; portions copyright TurboPower Software
  4.  
  5. MakeInfo is the utility you use to create additional databases for
  6. the InfoPop search engine.  The ASCII file SAMPLEDB.TXT gives
  7. complete information on how you create a database.  To see sampledb
  8. in action, type MAKEINFO sampledb [return] at the DOS prompt. Then
  9. activate InfoPop and press F3 to load a new database. Enter SAMPLEDB
  10. at the prompt for the new file.  You'll need to study SAMPLEDB.TXT
  11. to see what's required in terms of formatting the input file.
  12.  
  13.                     * * * * *  important!  * * * * *
  14.  
  15.          USE AN ASCII EDITOR TO VIEW and/or MODIFY SAMPLEDB.TXT
  16.                        OR ANY DATABASE YOU CREATE
  17.  
  18.                     * * * * * * * * * * * * * * * *
  19.  
  20. Basics:
  21.  
  22. Your input file must be plain ASCII text and end with a TXT extension.
  23.  
  24. You may comment the file by placing a ';' in the first character
  25.  position of the line.
  26.  
  27. No single topic can exceed 64K (of course, who would want to
  28.  page down through that much text?)
  29.  
  30. For each topic you add, you must assign a TOPIC NUMBER.
  31.  
  32. If you don't want that topic to appear in the initial window
  33.  (the main index), follow the !TOPIC # line with !NOINDEX.
  34.  
  35. MAKEINFO directives must begin with a ! in the first character
  36.  position of a line. The following sample entry shows what
  37.  you need to know about creating an entry
  38.  
  39. You can include multiple files to create your final HLP file,
  40. just use the !INCLUDE IncludeFileName directive in your main
  41. help file.  This way you can create a very large help file
  42. even though your editor isn't capable of keeping the whole
  43. thing in memory at once. Remember that your topic numbers
  44. must not conflict.
  45.  
  46. Don't use the Index number $FFFF (65535 decimal). MakeInfo uses
  47. this value to diable indexing for a particular topic.
  48. The rest of this file consists of text lifted from the sample
  49. database input file SAMPLEDB.TXT.  The semicolons that appear
  50. in the left margin are comment markers -- since in that file
  51. we don't want MakeInfo compiling that text into the database!
  52.  
  53. ;=================
  54. ;!TOPIC 15 My Favorite Internet Destination                  [a]
  55. ;!INDEX                                                      [b]
  56. ;My favorite destination is reached via TELNET 99.999.999  [c]
  57. ;It is the central database for the 20CIA                 [d]
  58. ;=========
  59. ;
  60. ;first, the sample lines have been labelled at right (a thru d).
  61. ;The important features of each line are described below.
  62. ;
  63. ;[a] Note the ! in the first position. This indicates to MAKEINFO
  64. ;    that a compiler directive follows. In this particular case,
  65. ;    it is a new topic (number 15). You should group your topics
  66. ;    by number range (to ease subsequent re-editing), but be aware
  67. ;    that leaving large gaps will have a negative impact on the
  68. ;    size of your final *.HLP file. A large gap is 50 or more
  69. ;    unused numbers.  The number you assign to a topic is the
  70. ;    number you use subsequently to cross-reference it (make a
  71. ;    hyperlink.  You can see a link made in line [d].
  72. ;    The !TOPIC text following the number appears as the header
  73. ;    for that topic's window.
  74. ;
  75. ;[b] This directive '!INDEX' tells MakeInfo to put this topic
  76. ;    on the opening menu of topics == what you get if you press
  77. ;    HOME when Infopop is running.  If you don't want the topic
  78. ;    to appear in the main topic, put !NOINDEX.  If you want
  79. ;    to force a topic to be first in the listing (MAKEINFO
  80. ;    defaults to an alphabetical listing of topics), put a
  81. ;    number after the !INDEX (e.g., !INDEX 1 would make it
  82. ;    first, !INDEX 5000 would make it last if you didn't have
  83. ;    more than 5000 topics. Don't assign the index # of
  84. ;    65535. MakeInfo uses that particular number to disable
  85. ;    indexing for a topic
  86. ;
  87. ;[c] This line would be the first line of text in the window
  88. ;    associated with topic 15.  Note the 's...this highlights
  89. ;    the term (makes it appear bold). It doesn't establish a
  90. ;    hyper link, it just provides a mechanism for bolding
  91. ;    text.  You create that symbol by holding down the ALT key
  92. ;    as you press 2 on the keypad.  Be sure to put the ALT-2
  93. ;    mark at the start of bolding at at the end of the text
  94. ;    string you want to appear in bold!
  95. ;
  96. ;    Another way to enter these characters with some editors
  97. ;    (e.g., the Turbo Pascal editor from Borland) is to
  98. ;    Press CTRL-P then CTRL-B (for bold).
  99. ;
  100.  
  101. ;[d] This line shows how you make a hyperlink. First press the
  102. ;    ALT key, then the 4 on the keypad. That puts a  symbol
  103. ;    in the text. Follow that with the number of the topic
  104. ;    you want to reference.  Follow the number with a  (ALT-5)
  105. ;    then type the text you want to use to reference the
  106. ;    linked topic (doesn't have to be the same as the text
  107. ;    that follows the !TOPIC directive for the topic you're
  108. ;    linking to), then follow that text with another  (ALT-5).
  109. ;
  110. ;    If using an editor that supports these characters via
  111. ;    CTRL-P, then the sequence (as discussed above) the
  112. ;    codes would be entered for this line like so:
  113. ;
  114. ;    It is the central database for the ^P^D20^P^ECIA^P^E
  115. ;
  116. ;Use these directives at the start of any supplemental file:
  117. ;
  118. ;=========
  119. !WIDTH 77
  120. !NOWRAP
  121. !SCROLLING
  122. ;=========
  123.  
  124. ;!WIDTH = width of text in window. If your line goes over that,
  125. ;         makeinfo will wrap it...unless of course you specify
  126. ;         !NOWRAP. I recommend you do, that way you can format
  127. ;         your text in the *.TXT file you use to create the
  128. ;         *.HLP file and it will appear just as you type it.
  129. ;         If you're going to draw a map or reproduce a screen
  130. ;         you really need the !NOWRAP directive.
  131. ;
  132. ;!SCROLLING = means you allow the user to scroll the window to see
  133. ;             text that won't fit in the window.
  134. ;
  135. ;What follows is a small sample file
  136. !TOPIC 1 About this database
  137. !INDEX 1
  138. This is a sample file that shows how you can create your own InfoPop
  139. supplemental database.  Be sure to read the SAMPLE.TXT file that
  140. was used to create this demo. It explains how you must write the
  141. file.
  142.  
  143. Note that you must use an 2ASCII editor to create a supplemental
  144. file. Then you must run it through 3MakeInfo to create the
  145. resulting *.HLP file that you can load into Infopop.
  146. ;=====
  147. !TOPIC 2 ASCII
  148. !NOINDEX
  149. Not a word processor...A really nice ASCII editor is QEDIT. Others
  150. that will work are BOXER, PC-WRITE, or perhaps even WordPerfect
  151. (just as long as you remember to save the file as an ASCII (DOS
  152. text) file (CTRL-F5).
  153. ;====
  154. !TOPIC 3 MakeInfo
  155. !NOINDEX
  156. Makeinfo is a utility that will turn your *.TXT file into a database
  157. that 4InfoPop can read and use.  The ASCII text file will be
  158. converted to binary form and compressed.
  159. ;====
  160. ;
  161. ; Note in this case, there is no !INDEX directive. Omitting !NOINDEX
  162. ; will force this entry into the main index, displaying it in
  163. ; alphabetical order
  164. ;--------
  165. !TOPIC 4 InfoPop
  166. InfoPop (from 5GMUtant Software) is the whole point of this. IP.EXE
  167. (the program) is what you use as the hypertext search engine for
  168. your helpfile.
  169.  
  170. ;=======
  171. !TOPIC 5 GMUtant Software
  172.  
  173. InfoPop and MakeInfo are not public domain.  You may freely use,
  174. fcopy and distribute the InfoPop package, provided that you
  175. distribute all files contained in the archive. Any distribution
  176. of InfoPop must include: IP.EXE, INFOPOP.HLP, IP.DOC, MAKEINFO.EXE and
  177. SAMPLEDB.TXT.
  178.  
  179. You may create your own databases, compile them with MakeInfo
  180. and distribute them if you wish.
  181.  
  182. Author: Clyde W. Grotophorst
  183.  email: wallyg@fen1.gmu.edu
  184.  
  185. ;=====
  186. ;
  187. ; NOTE that you may have no more than 175 cross-references per
  188. ; topic. Thus, if you had more than 175 topics you would have
  189. ; to break your index up so that no one topic (in this case, the
  190. ; index), would be linked to more than 175 other topics or
  191. ; have more than 175 topics linked to it
  192. ;
  193. ;=======
  194. !TOPIC 6 Index
  195.  
  196. Here are the topics covered in this database.
  197.  
  198. 1About Sampledb
  199. 2ASCII
  200. 5GMUtant Software
  201. 4InfoPop
  202. 3MakeInfo
  203. ;=============================
  204.  
  205.  
  206.  
  207.